﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Open.ChannelExtensions </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Open.ChannelExtensions ">
    <meta name="generator" content="docfx 2.47.0.0">
    
    <link rel="shortcut icon" href="../favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    
    
    
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="">
<h1 id="openchannelextensions">Open.ChannelExtensions</h1>

<p>A set of extensions for optimizing/simplifying System.Threading.Channels usage.</p>
<h2 id="highlights">Highlights</h2>
<p>Being able to define an asynchronous pipeline with best practice usage using simple expressive syntax:</p>
<pre><code class="lang-cs">await Channel
    .CreateBounded&lt;T&gt;(10)
    .SourceAsync(source /* IEnumerable&lt;Task&lt;T&gt;&gt; */)
    .PipeAsync(
        maxConcurrency: 2,
        capacity: 5,
        transform: asyncTransform01)
    .Pipe(transform02, /* capacity */ 3)
    .ReadAllAsync(finalTransformedValue =&gt; {
        // Do something async with each final value.
    });
</code></pre>
<pre><code class="lang-cs">await source /* IEnumerable&lt;T&gt; */
    .ToChannel(boundedSize: 10, singleReader: true)
    .PipeAsync(asyncTransform01, /* capacity */ 5)
    .Pipe(
        maxConcurrency: 2,
        capacity: 3,
        transform: transform02)
    .ReadAll(finalTransformedValue =&gt; {
        // Do something with each final value.
    });
</code></pre>
<h2 id="examples">Examples</h2>
<h3 id="reading-until-the-channel-is-closed">Reading (until the channel is closed)</h3>
<h4 id="one-by-one-read-each-entry-from-the-channel">One by one read each entry from the channel</h4>
<pre><code class="lang-cs">await channel.ReadAll(
    entry =&gt; { /* Processing Code */ });
</code></pre>
<pre><code class="lang-cs">await channel.ReadAll(
    (entry, index) =&gt; { /* Processing Code */ });
</code></pre>
<pre><code class="lang-cs">await channel.ReadAllAsync(
    async entry =&gt; { await /* Processing Code */ });
</code></pre>
<pre><code class="lang-cs">await channel.ReadAllAsync(
    async (entry, index) =&gt; { await /* Processing Code */ });
</code></pre>
<h4 id="read-concurrently-each-entry-from-the-channel">Read concurrently each entry from the channel</h4>
<pre><code class="lang-cs">await channel.ReadAllConcurrently(
    maxConcurrency,
    entry =&gt; { /* Processing Code */ });
</code></pre>
<pre><code class="lang-cs">await channel.ReadAllConcurrentlyAsync(
    maxConcurrency,
    async entry =&gt; { await /* Processing Code */ });
</code></pre>
<h3 id="writing">Writing</h3>
<p>If <code>complete</code> is <code>true</code>, the channel will be closed when the source is empty.</p>
<h4 id="dump-a-source-enumeration-into-the-channel">Dump a source enumeration into the channel</h4>
<pre><code class="lang-cs">// source can be any IEnumerable&lt;T&gt;.
await channel.WriteAll(source, complete: true);
</code></pre>
<pre><code class="lang-cs">// source can be any IEnumerable&lt;Task&lt;T&gt;&gt; or IEnumerable&lt;ValueTask&lt;T&gt;&gt;.
await channel.WriteAllAsync(source, complete: true);
</code></pre>
<h4 id="synchronize-reading-from-the-source-and-process-the-results-concurrently">Synchronize reading from the source and process the results concurrently</h4>
<pre><code class="lang-cs">// source can be any IEnumerable&lt;Task&lt;T&gt;&gt; or IEnumerable&lt;ValueTask&lt;T&gt;&gt;.
await channel.WriteAllConcurrentlyAsync(
    maxConcurrency, source, complete: true);
</code></pre>
<h3 id="pipelining--transforming">Pipelining / Transforming</h3>
<h4 id="transform-and-buffer-entries">Transform and buffer entries</h4>
<pre><code class="lang-cs">// Transform values in a source channel to new unbounded channel.
var transformed = channel.Pipe(
    async value =&gt; /* transformation */);
</code></pre>
<pre><code class="lang-cs">// Transform values in a source channel to new unbounded channel with a max concurrency of X.
const X = 4;
var transformed = channel.Pipe(
    X, async value =&gt; /* transformation */);
</code></pre>
<pre><code class="lang-cs">// Transform values in a source channel to new bounded channel bound of N entries.
const N = 5;
var transformed = channel.Pipe(
    async value =&gt; /* transformation */, N);
</code></pre>
<pre><code class="lang-cs">// Transform values in a source channel to new bounded channel bound of N entries with a max concurrency of X.
const X = 4;
const N = 5;
var transformed = channel.Pipe(
    X, async value =&gt; /* transformation */, N);

// or
transformed = channel.Pipe(
    maxConcurrency: X,
    capacity: N,
    transform: async value =&gt; /* transformation */);
</code></pre>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                  <li>
                    <a href="https://github.com/electricessence/Open.ChannelExtensions/blob/master/docfx/api/index.md/#L1" class="contribution-link">Improve this Doc</a>
                  </li>
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
